RunAnalysis(IProject,Action<IAnalysisLog>,Action<IProgressLog>,String) Method

Runs a full analysis on this project, in-process and synchronously. (Only available with a Build Machine license).

Syntax

[Extension()]
public static IAnalysisResult RunAnalysis( 
   IProject project,
   Action<IAnalysisLog> analysisLogHandler,
   Action<IProgressLog> progressLogHandler,
   string analysisResultId
)

Parameters

project: This NDepend project to analyze.
analysisLogHandler: A procedure delegate object invoked each time the current analysis run emits a new IAnalysisLog object.
progressLogHandler: A procedure delegate object invoked each time the current analysis run emits a new IProgressLog object.
analysisResultId: (Optional) An id to identify the analysis result build by this call.

Return Value

The analysis result.

Exceptions

Exception	Description
System.Exception	Cannot run analysis without a Build Machine license.
AnalysisException	The analysis execution failed. The InnerException contains additional information concerning the failure.
System.Xml.XmlException	The project file might be corrupted.
System.ArgumentException	The string for analysisResultId is invalid. It must be trimmed, a length of maximum 64 characters, excluding characters that cannot fit in a file name \ / : * ? " > < \|

Remarks

Calling this method will typically takes a few seconds, the time the analysis is performed.
The analysis result is persisted in the project.Properties.NDepend.Project.IProjectProperties.OutputDir directory.
It is possible to run several analysis simultaneously on several threads in the same AppDomain.

Requirements

Target Platforms: Windows 11, 10, 8, 7 and Linux, MacOS with net8.0, net7.0 or net6.0 installed

Reference

ExtensionMethodsProjectAnalysis Class
ExtensionMethodsProjectAnalysis Members
Overload List